Product Generator

The Product Generator is new equipment available from Sym3 V5.2.

Properties

Name Type Description
Name String Gets/Sets the product generator name. By default this will be ProductGeneratorX where X is the next incremental number for this equipment.
Alias String Gets/Sets the product alternative name to display in the tooltip
Identifier String Gets/Sets the Identifier of the products for generated products
Identified Boolean Gets/Sets the Identified property for generated products
Destination Array of Integer Gets/Sets the list of comma separated Destination numbers for generated products
Screening Array of Integer Gets/Sets the list of comma separated Screening numbers for generated products
Width Number Width of the product item ( in the units chosen when the project was created (metres or feet)) for generated products
Length Number Length of the product item ( in the units chosen when the project was created (metres or feet)) for generated products
Height Number Height of the product item ( in the units chosen when the project was created (metres or feet)) for generated products
Direction Number Rotation of the product (in degrees) for generated products
Shape (V5) String Gets/Sets the name of the Product Shape for generated products. Will be '' if set to the default of a cube
Color Object Gets/Sets the Color property for generated products.
Visible Boolean New in V7.0. Gets/Sets the visibility of the equipment

 

Events

OnProductCreate

Invoked when the product is created (may be in a product schedule queue).

Note: This event does not support multiple subscription. Previous subscription will be lost if subscribe twice.

Callback Signature

void xxxxxxxxxxxxxxxxx (product: Product, generator: ProductGenerator);

Note: This event is subscribed to via the ‘SubscribeAll’ global function. As product components are transient using the ‘Subscribe’ method will result in an error.

Name Type Description
product Product The product object created
generator ProductGenerator The Product Generator that created the product

Functions

Product CreateProductFrom(generator: ProductGenerator);

Called to create a new instance of product from a Product Generator.

Return Value – An instance of the product type or null on error